<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>MiXiM: D:/Projects/MiXiM/extsrc/mixim/src/inet_stub/mobility/models/MobilityBase.h Source File</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>


</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">MiXiM
   &#160;<span id="projectnumber">2.3</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('a00363.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">MobilityBase.h</div>  </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- mode:c++ -*- ********************************************************</span>
<a name="l00002"></a>00002 <span class="comment"> * file:        MobilityBase.h</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * author:      Daniel Willkomm, Andras Varga</span>
<a name="l00005"></a>00005 <span class="comment"> *</span>
<a name="l00006"></a>00006 <span class="comment"> * copyright:   (C) 2004 Telecommunication Networks Group (TKN) at</span>
<a name="l00007"></a>00007 <span class="comment"> *              Technische Universitaet Berlin, Germany.</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> *              (C) 2005 Andras Varga</span>
<a name="l00010"></a>00010 <span class="comment"> *</span>
<a name="l00011"></a>00011 <span class="comment"> *              This program is free software; you can redistribute it</span>
<a name="l00012"></a>00012 <span class="comment"> *              and/or modify it under the terms of the GNU General Public</span>
<a name="l00013"></a>00013 <span class="comment"> *              License as published by the Free Software Foundation; either</span>
<a name="l00014"></a>00014 <span class="comment"> *              version 2 of the License, or (at your option) any later</span>
<a name="l00015"></a>00015 <span class="comment"> *              version.</span>
<a name="l00016"></a>00016 <span class="comment"> *              For further information see file COPYING</span>
<a name="l00017"></a>00017 <span class="comment"> *              in the top level directory</span>
<a name="l00018"></a>00018 <span class="comment"> ***************************************************************************</span>
<a name="l00019"></a>00019 <span class="comment"> * part of:     framework implementation developed by tkn</span>
<a name="l00020"></a>00020 <span class="comment"> **************************************************************************/</span>
<a name="l00021"></a>00021 
<a name="l00022"></a>00022 
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef MOBILITY_BASE_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define MOBILITY_BASE_H</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &quot;INETDefs.h&quot;</span>
<a name="l00027"></a>00027 
<a name="l00028"></a>00028 <span class="preprocessor">#include &quot;Coord.h&quot;</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include &quot;BasicModule.h&quot;</span>
<a name="l00030"></a>00030 <span class="preprocessor">#include &quot;IMobility.h&quot;</span>
<a name="l00031"></a>00031 
<a name="l00032"></a>00032 
<a name="l00053"></a><a class="code" href="a00145.html">00053</a> <span class="keyword">class </span>INET_API <a class="code" href="a00145.html" title="Abstract base class for mobility modules.">MobilityBase</a> : <span class="keyword">public</span> <a class="code" href="a00031.html" title="Base class for all simple modules of a host that want to have access to the NotificationBoard module...">BasicModule</a>, <span class="keyword">public</span> <a class="code" href="a00101.html" title="Abstract base class defining the public interface that must be provided by all mobility modules...">IMobility</a>
<a name="l00054"></a>00054 {
<a name="l00055"></a>00055   <span class="keyword">public</span>:
<a name="l00060"></a><a class="code" href="a00145.html#aa67dcad3ed1e7fe0164b84131aea2b18">00060</a>     <span class="keyword">enum</span> <a class="code" href="a00145.html#aa67dcad3ed1e7fe0164b84131aea2b18">BorderPolicy</a> {
<a name="l00061"></a><a class="code" href="a00145.html#aa67dcad3ed1e7fe0164b84131aea2b18add05fd1c0ea65bba1c8e25fe7742acca">00061</a>         <a class="code" href="a00145.html#aa67dcad3ed1e7fe0164b84131aea2b18add05fd1c0ea65bba1c8e25fe7742acca" title="reflect off the wall">REFLECT</a>,       
<a name="l00062"></a><a class="code" href="a00145.html#aa67dcad3ed1e7fe0164b84131aea2b18a4dd7d01ab62c958cb7b3cb27f78a490a">00062</a>         <a class="code" href="a00145.html#aa67dcad3ed1e7fe0164b84131aea2b18a4dd7d01ab62c958cb7b3cb27f78a490a" title="reappear at the opposite edge (torus)">WRAP</a>,          
<a name="l00063"></a><a class="code" href="a00145.html#aa67dcad3ed1e7fe0164b84131aea2b18a7fe0cd1ed529388e665b7e898596c236">00063</a>         <a class="code" href="a00145.html#aa67dcad3ed1e7fe0164b84131aea2b18a7fe0cd1ed529388e665b7e898596c236" title="placed at a randomly chosen position within the constraint area">PLACERANDOMLY</a>, 
<a name="l00064"></a><a class="code" href="a00145.html#aa67dcad3ed1e7fe0164b84131aea2b18a0e070e3cd7ad937cb82bc15dbe81e918">00064</a>         RAISEERROR     
<a name="l00065"></a>00065     };
<a name="l00066"></a>00066 
<a name="l00067"></a>00067   <span class="keyword">protected</span>:
<a name="l00069"></a><a class="code" href="a00145.html#a10491208fc1f207870d49401de1ae52c">00069</a>     <span class="keyword">static</span> simsignal_t <a class="code" href="a00145.html#a10491208fc1f207870d49401de1ae52c" title="A signal used to publish mobility state changes.">mobilityStateChangedSignal</a>;
<a name="l00070"></a>00070 
<a name="l00072"></a><a class="code" href="a00145.html#a3df52e779977d443eae7e5edee8fc7b9">00072</a>     cModule* <a class="code" href="a00145.html#a3df52e779977d443eae7e5edee8fc7b9" title="Pointer to visual representation module, to speed up repeated access.">visualRepresentation</a>;
<a name="l00073"></a>00073 
<a name="l00075"></a><a class="code" href="a00145.html#a5b75464ca5724b99186e8577f8345ed8">00075</a>     <a class="code" href="a00065.html" title="Class for storing 3D coordinates.">Coord</a> <a class="code" href="a00145.html#a5b75464ca5724b99186e8577f8345ed8" title="3 dimensional position and size of the constraint area (in meters).">constraintAreaMin</a>, constraintAreaMax;
<a name="l00076"></a>00076 
<a name="l00078"></a><a class="code" href="a00145.html#a82ae637969433a492154b26039b84038">00078</a>     <a class="code" href="a00065.html" title="Class for storing 3D coordinates.">Coord</a> <a class="code" href="a00145.html#a82ae637969433a492154b26039b84038" title="The last position that was reported.">lastPosition</a>;
<a name="l00079"></a>00079 
<a name="l00080"></a>00080   <span class="keyword">protected</span>:
<a name="l00081"></a>00081     <a class="code" href="a00145.html" title="Abstract base class for mobility modules.">MobilityBase</a>();
<a name="l00082"></a>00082 
<a name="l00084"></a><a class="code" href="a00145.html#ac86018a375bf83f14dc36bf222bfd5bd">00084</a>     <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="a00145.html#ac86018a375bf83f14dc36bf222bfd5bd" title="Returns the required number of initialize stages.">numInitStages</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> 2;}
<a name="l00085"></a>00085 
<a name="l00087"></a>00087     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a00031.html#ae0497ccac7ad62630013847a8985dd4e" title="Basic initialization for all modules.">initialize</a>(<span class="keywordtype">int</span> stage);
<a name="l00088"></a>00088 
<a name="l00090"></a>00090     <span class="keyword">virtual</span> <span class="keywordtype">void</span> initializePosition();
<a name="l00091"></a>00091 
<a name="l00093"></a>00093     <span class="keyword">virtual</span> <span class="keywordtype">void</span> handleMessage(cMessage *msg);
<a name="l00094"></a>00094 
<a name="l00096"></a>00096     <span class="keyword">virtual</span> <span class="keywordtype">void</span> handleSelfMessage(cMessage *msg) = 0;
<a name="l00097"></a>00097 
<a name="l00099"></a>00099     <span class="keyword">virtual</span> <span class="keywordtype">void</span> updateVisualRepresentation();
<a name="l00100"></a>00100 
<a name="l00102"></a>00102     <span class="keyword">virtual</span> <span class="keywordtype">void</span> emitMobilityStateChangedSignal();
<a name="l00103"></a>00103 
<a name="l00105"></a>00105     <span class="keyword">virtual</span> <a class="code" href="a00065.html" title="Class for storing 3D coordinates.">Coord</a> getRandomPosition();
<a name="l00106"></a>00106 
<a name="l00108"></a><a class="code" href="a00145.html#a39ea0e8ddefc5b5b30ae969f3a2d8b43">00108</a>     <span class="keyword">virtual</span> cModule *<a class="code" href="a00145.html#a39ea0e8ddefc5b5b30ae969f3a2d8b43" title="Returns the module that represents the object moved by this mobility module.">findVisualRepresentation</a>() { <span class="keywordflow">return</span> <a class="code" href="a00031.html#aa05d2372f6004febdbcb02175f218369" title="Function to get a pointer to the host module.">findHost</a>(); }
<a name="l00109"></a>00109 
<a name="l00111"></a>00111     <span class="keyword">virtual</span> <span class="keywordtype">bool</span> isOutside();
<a name="l00112"></a>00112 
<a name="l00119"></a>00119     <span class="keyword">virtual</span> <span class="keywordtype">void</span> reflectIfOutside(<a class="code" href="a00065.html" title="Class for storing 3D coordinates.">Coord</a>&amp; targetPosition, <a class="code" href="a00065.html" title="Class for storing 3D coordinates.">Coord</a>&amp; speed, <span class="keywordtype">double</span>&amp; angle);
<a name="l00120"></a>00120 
<a name="l00127"></a>00127     <span class="keyword">virtual</span> <span class="keywordtype">void</span> wrapIfOutside(<a class="code" href="a00065.html" title="Class for storing 3D coordinates.">Coord</a>&amp; targetPosition);
<a name="l00128"></a>00128 
<a name="l00135"></a>00135     <span class="keyword">virtual</span> <span class="keywordtype">void</span> placeRandomlyIfOutside(<a class="code" href="a00065.html" title="Class for storing 3D coordinates.">Coord</a>&amp; targetPosition);
<a name="l00136"></a>00136 
<a name="l00140"></a>00140     <span class="keyword">virtual</span> <span class="keywordtype">void</span> raiseErrorIfOutside();
<a name="l00141"></a>00141 
<a name="l00145"></a>00145     <span class="keyword">virtual</span> <span class="keywordtype">void</span> handleIfOutside(BorderPolicy policy, <a class="code" href="a00065.html" title="Class for storing 3D coordinates.">Coord</a>&amp; targetPosition, <a class="code" href="a00065.html" title="Class for storing 3D coordinates.">Coord</a>&amp; speed, <span class="keywordtype">double</span>&amp; angle);
<a name="l00146"></a>00146 };
<a name="l00147"></a>00147 
<a name="l00148"></a>00148 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><b>MobilityBase.h</b>      </li>

    <li class="footer">Generated on Tue Mar 5 2013 21:26:30 for MiXiM by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
   </ul>
 </div>


</body>
</html>
